<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>csudma: xcsudma.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">csudma
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xcsudma_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xcsudma.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaf448568bb484f8b80052682f399f194d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#gaf448568bb484f8b80052682f399f194d">XCSUDMA_WORD_SIZE</a>&#160;&#160;&#160;(4U)</td></tr>
<tr class="memdesc:gaf448568bb484f8b80052682f399f194d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transfer size conversion to bytes for Versal Net.  <a href="group__csuma__api.html#gaf448568bb484f8b80052682f399f194d">More...</a><br/></td></tr>
<tr class="separator:gaf448568bb484f8b80052682f399f194d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad0f7217bd295de82623179efb34adb96"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#gad0f7217bd295de82623179efb34adb96">XCsuDma_CfgInitialize</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="struct_x_csu_dma___config.html">XCsuDma_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:gad0f7217bd295de82623179efb34adb96"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes CSU_DMA core.  <a href="group__csuma__api.html#gad0f7217bd295de82623179efb34adb96">More...</a><br/></td></tr>
<tr class="separator:gad0f7217bd295de82623179efb34adb96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacf79144df19e9cd4116dd9f507037ff1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#gacf79144df19e9cd4116dd9f507037ff1">XCsuDma_Transfer</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel, u64 Addr, u32 Size, u8 EnDataLast)</td></tr>
<tr class="memdesc:gacf79144df19e9cd4116dd9f507037ff1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the starting address and size of the data to be transferred from/to the memory through the AXI interface.  <a href="group__csuma__api.html#gacf79144df19e9cd4116dd9f507037ff1">More...</a><br/></td></tr>
<tr class="separator:gacf79144df19e9cd4116dd9f507037ff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga83a1043112b6067b1901d2bdcb29563d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#ga83a1043112b6067b1901d2bdcb29563d">XCsuDma_64BitTransfer</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel, u32 AddrLow, u32 AddrHigh, u32 Size, u8 EnDataLast)</td></tr>
<tr class="memdesc:ga83a1043112b6067b1901d2bdcb29563d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the starting address and size of the data to be transferred from/to the memory through the AXI interface.  <a href="group__csuma__api.html#ga83a1043112b6067b1901d2bdcb29563d">More...</a><br/></td></tr>
<tr class="separator:ga83a1043112b6067b1901d2bdcb29563d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga25049be545d8ec6eae2426b6248a8e4f"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#ga25049be545d8ec6eae2426b6248a8e4f">XCsuDma_GetAddr</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel)</td></tr>
<tr class="memdesc:ga25049be545d8ec6eae2426b6248a8e4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the current address location of the memory, from where it has to read the data(SRC) or the location where it has to write the data (DST) based on the channel selection.  <a href="group__csuma__api.html#ga25049be545d8ec6eae2426b6248a8e4f">More...</a><br/></td></tr>
<tr class="separator:ga25049be545d8ec6eae2426b6248a8e4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad5fd579fb9c166e59ee1f9d3b39250c7"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#gad5fd579fb9c166e59ee1f9d3b39250c7">XCsuDma_GetSize</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel)</td></tr>
<tr class="memdesc:gad5fd579fb9c166e59ee1f9d3b39250c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the size of the data yet to be transferred from memory to CSU_DMA or CSU_DMA to memory based on the channel selection.  <a href="group__csuma__api.html#gad5fd579fb9c166e59ee1f9d3b39250c7">More...</a><br/></td></tr>
<tr class="separator:gad5fd579fb9c166e59ee1f9d3b39250c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga00b5080126710866186d0bfafd26e9b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#ga00b5080126710866186d0bfafd26e9b6">XCsuDma_Pause</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel, <a class="el" href="xcsudma_8h.html#ad5ce08d197288cbdfb06941f1d46df87">XCsuDma_PauseType</a> Type)</td></tr>
<tr class="memdesc:ga00b5080126710866186d0bfafd26e9b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function pauses the Channel data transfer to/from memory or to/from stream based on pause type.  <a href="group__csuma__api.html#ga00b5080126710866186d0bfafd26e9b6">More...</a><br/></td></tr>
<tr class="separator:ga00b5080126710866186d0bfafd26e9b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa3450f812658f927f289b997b12a4174"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#gaa3450f812658f927f289b997b12a4174">XCsuDma_IsPaused</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel, <a class="el" href="xcsudma_8h.html#ad5ce08d197288cbdfb06941f1d46df87">XCsuDma_PauseType</a> Type)</td></tr>
<tr class="memdesc:gaa3450f812658f927f289b997b12a4174"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks whether Channel memory/stream is paused based on the given pause type.  <a href="group__csuma__api.html#gaa3450f812658f927f289b997b12a4174">More...</a><br/></td></tr>
<tr class="separator:gaa3450f812658f927f289b997b12a4174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeee3f2d5bcf265b57c9f214f2bc15a28"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#gaeee3f2d5bcf265b57c9f214f2bc15a28">XCsuDma_Resume</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel, <a class="el" href="xcsudma_8h.html#ad5ce08d197288cbdfb06941f1d46df87">XCsuDma_PauseType</a> Type)</td></tr>
<tr class="memdesc:gaeee3f2d5bcf265b57c9f214f2bc15a28"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resumes the channel if it is in paused state and continues where it has left.  <a href="group__csuma__api.html#gaeee3f2d5bcf265b57c9f214f2bc15a28">More...</a><br/></td></tr>
<tr class="separator:gaeee3f2d5bcf265b57c9f214f2bc15a28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17f1a7ba935f4bf3626050e0b0e0142b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#ga17f1a7ba935f4bf3626050e0b0e0142b">XCsuDma_GetCheckSum</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga17f1a7ba935f4bf3626050e0b0e0142b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the sum of all the data read from AXI memory.  <a href="group__csuma__api.html#ga17f1a7ba935f4bf3626050e0b0e0142b">More...</a><br/></td></tr>
<tr class="separator:ga17f1a7ba935f4bf3626050e0b0e0142b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78bdd79674e2b5c92b9701cacfde1fe1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#ga78bdd79674e2b5c92b9701cacfde1fe1">XCsuDma_ClearCheckSum</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga78bdd79674e2b5c92b9701cacfde1fe1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function clears the check sum of the data read from AXI memory.  <a href="group__csuma__api.html#ga78bdd79674e2b5c92b9701cacfde1fe1">More...</a><br/></td></tr>
<tr class="separator:ga78bdd79674e2b5c92b9701cacfde1fe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga73867b4acb189982642e4c1ae4f92fb9"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#ga73867b4acb189982642e4c1ae4f92fb9">XCsuDma_WaitForDoneTimeout</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel)</td></tr>
<tr class="memdesc:ga73867b4acb189982642e4c1ae4f92fb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function polls for completion of data transfer periodically until the DMA done bit set or until the timeout occurs.  <a href="group__csuma__api.html#ga73867b4acb189982642e4c1ae4f92fb9">More...</a><br/></td></tr>
<tr class="separator:ga73867b4acb189982642e4c1ae4f92fb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac9b6265e467b03cc903cd66781e95e63"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#gac9b6265e467b03cc903cd66781e95e63">XCsuDma_SetConfig</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel, <a class="el" href="struct_x_csu_dma___configure.html">XCsuDma_Configure</a> *ConfigurValues)</td></tr>
<tr class="memdesc:gac9b6265e467b03cc903cd66781e95e63"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures all the values of CSU_DMA Channels with the values of updated <a class="el" href="struct_x_csu_dma___configure.html" title="This typedef contains all the configuration feilds which must be set before the start of the data tra...">XCsuDma_Configure</a> structure.  <a href="group__csuma__api.html#gac9b6265e467b03cc903cd66781e95e63">More...</a><br/></td></tr>
<tr class="separator:gac9b6265e467b03cc903cd66781e95e63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab0b66bca3f38d26d38ff47544fa6b11"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__csuma__api.html#gaab0b66bca3f38d26d38ff47544fa6b11">XCsuDma_GetConfig</a> (<a class="el" href="struct_x_csu_dma.html">XCsuDma</a> *InstancePtr, <a class="el" href="group__csuma__api.html#ga46008337fdd632f2650b8727c305eba5">XCsuDma_Channel</a> Channel, <a class="el" href="struct_x_csu_dma___configure.html">XCsuDma_Configure</a> *ConfigurValues)</td></tr>
<tr class="memdesc:gaab0b66bca3f38d26d38ff47544fa6b11"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function updates <a class="el" href="struct_x_csu_dma___configure.html" title="This typedef contains all the configuration feilds which must be set before the start of the data tra...">XCsuDma_Configure</a> structure members with the configured values of CSU_DMA's Channel.  <a href="group__csuma__api.html#gaab0b66bca3f38d26d38ff47544fa6b11">More...</a><br/></td></tr>
<tr class="separator:gaab0b66bca3f38d26d38ff47544fa6b11"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
